Class AsaObjectImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.AsaObjectImpl
All Implemented Interfaces:
IPCObject, AsaObject

public class AsaObjectImpl extends IPCObjectImpl implements AsaObject
Information provided by the PKI file:

    \class CAsaObject
    
    \brief CAsaObject is the asa object storage manager class that is used to store and retrieve asa object.
    
    \example network().getDevice("Router0").getObjectManager()->getObjectByName("objectName")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getObjectName

      public String getObjectName()
      Information provided by the PKI file:
      
          \brief Return the asa object name
          
          \return string, value is the asa object name.
          
              
      Specified by:
      getObjectName in interface AsaObject
      Returns:
      String Returns a String
    • setObjectName

      public void setObjectName(String objectName)
      Information provided by the PKI file:
      
          \brief Return the asa object name
          
          \param objectName, value is the name to give the object.
          
              
      Specified by:
      setObjectName in interface AsaObject
      Parameters:
      objectName - Takes in a parameter of objectName
    • getObjectType

      public ObjectType getObjectType()
      Information provided by the PKI file:
      
          \brief Return the asa object type
          type - asa object type, values:             eNetwork = 0,
          eService = 1,
          eGroupService = 2,
          eGroupServiceTcp = 3,
          eGroupServiceUdp = 4,
          eGroupServiceTcpUdp = 5,
          eGroupNetwork = 6,
          eWebvpn = 7
          \return ObjectType, value is the asa object type.
          
              
      Specified by:
      getObjectType in interface AsaObject
      Returns:
      ObjectType Returns a ObjectType
    • getDescription

      public String getDescription()
      Information provided by the PKI file:
      
          \brief Return the asa object description
          
          \return string, value is the description.
          
              
      Specified by:
      getDescription in interface AsaObject
      Returns:
      String Returns a String
    • setDescription

      public void setDescription(String description)
      Information provided by the PKI file:
      
          \brief Set the description of the asa object
          
          \param description, value is the description to use for the object.
          
              
      Specified by:
      setDescription in interface AsaObject
      Parameters:
      description - Takes in a parameter of description
    • isReferenced

      public boolean isReferenced()
      Information provided by the PKI file:
      
          \brief Check to see if the asa object is being used by other classes
          
          \return bool, Value is true if the asa object is being used by other classes, false if not.
          
              
      Specified by:
      isReferenced in interface AsaObject
      Returns:
      boolean Returns a boolean
    • addReferenceObject

      public void addReferenceObject(String reference)
      Information provided by the PKI file:
      
          \brief Any class that has reference to the asa object calls this function to confirm its association with the object
          
          \param reference, a unique string to identify which object that has association with the asa object
          
              
      Specified by:
      addReferenceObject in interface AsaObject
      Parameters:
      reference - Takes in a parameter of reference
    • removeReferenceObject

      public void removeReferenceObject(String reference)
      Information provided by the PKI file:
      
          \brief Any class that has reference to asa object calls this function to release its association with the object
          
          \param reference, a unique string to identify which object that has association with the asa object
          
              
      Specified by:
      removeReferenceObject in interface AsaObject
      Parameters:
      reference - Takes in a parameter of reference
    • toString

      public String toString()
      Information provided by the PKI file:
      
          \brief Return the string configuration of the asa object
          
          \return string, value is the string configuration of the asa object.
          
              
      Specified by:
      toString in interface AsaObject
      Overrides:
      toString in class Object
      Returns:
      String Returns a String
    • getObjectServiceTypeString

      public String getObjectServiceTypeString()
      Information provided by the PKI file:
      
          \brief Return the string configuration for object-group of service type
          
          \return string, value is the string configuration for object-group of service type.
          
              
      Specified by:
      getObjectServiceTypeString in interface AsaObject
      Returns:
      String Returns a String